home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / sf2pk200.zip / SFPTOPK.TXT < prev   
Text File  |  1992-04-15  |  34KB  |  824 lines
  1.   [This ASCII version of the documentation is provided for on-line reference]
  2.   [only, it is not intended as a substitute for the "real" documentation    ]
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                                   SFPtoPK
  31.  
  32.     SFPtoPK converts HP LaserJet softfont files into TeX PK & TFM files
  33.  
  34.                                 Version 2.0
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.               Copyright (c) 1991-92 by Small Planet Software
  61.  
  62.                             All Rights Reserved
  63.  
  64.  
  65.  
  66.  
  67.         THIS PROGRAM IS ABSOLUTELY FREE. THIS PROGRAM IS  PROVIDED
  68.         ``AS IS'' WITHOUT WARRANTY  OF ANY KIND, EITHER  EXPRESSED
  69.         OR  IMPLIED,  INCLUDING  BUT  NOT  LIMITED TO, THE IMPLIED
  70.         WARRANTIES   OF   MERCHANTABILITY   AND   FITNESS   FOR  A
  71.         PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY  AND
  72.         PERFORMANCE  OF  THE  PROGRAM  IS  WITH  YOU.   SHOULD THE
  73.         PROGRAM  PROVE  DEFECTIVE,  YOU  ASSUME  THE  COST  OF ALL
  74.         NECESSARY SERVICING, REPAIR OR CORRECTION.
  75.  
  76.         IN NO  EVENT WILL  ANY COPYRIGHT  HOLDER BE  LIABLE TO YOU
  77.         FOR DAMAGES,  INCLUDING ANY  GENERAL, SPECIAL,  INCIDENTAL
  78.         OR  CONSEQUENTIAL  DAMAGES  ARISING  OUT  OF  THE  USE  OR
  79.         INABILITY TO  USE THE  PROGRAM (INCLUDING  BUT NOT LIMITED
  80.         TO  LOSS  OF  DATA  OR  DATA  BEING RENDERED INACCURATE OR
  81.         LOSSES SUSTAINED BY YOU OR  THIRD PARTIES OR A FAILURE  OF
  82.         THE PROGRAM TO OPERATE  WITH ANY OTHER PROGRAMS),  EVEN IF
  83.         SUCH  HOLDER  OR  OTHER  PARTY  HAS  BEEN  ADVISED  OF THE
  84.         POSSIBILITY OF SUCH DAMAGES.
  85.  
  86.   Every reasonable effort has been made to assure the quality and
  87.   completeness of this program, if you have any questions, comments, or
  88.   suggestions or if you believe that you have found a bug please contact
  89.   the author at the address given at the end of this document.
  90.  
  91.   All trademarks used within this document are trademarks of their
  92.   respective owners.
  93.  
  94. Changes (what's new and exciting)
  95. ---------------------------------
  96.  
  97.  Version 2.0
  98.  
  99.  o Added support for HP AutoFont Support files.
  100.  
  101.  Version 1.35
  102.  
  103.  o Added mathmatical calculation of space parameters (see /spacenorm...)
  104.  
  105.  o Fixed bug that prevented /spaceadj from being negative
  106.  
  107.  o Added space and space adjustment to configuration file
  108.  
  109.  Version 1.34
  110.  
  111.  o Made SFPtoPK report attempts to delete explicitly (re)mapped characters
  112.  
  113.  Version 1.33
  114.  
  115.  o Faster I/O on some softfonts, minor documentation changes
  116.  
  117.  Version 1.32
  118.  
  119.  o Included PKscale program for creating scaled PK files
  120.  
  121.  o Improved speed of ``scanning font'' code for most fonts
  122.  
  123.  o Fixed bug that caused SFPtoPK to miss some accent problems
  124.  
  125.  Version 1.31
  126.  
  127.  o Never officially released
  128.  
  129.  Version 1.3
  130.  
  131.  o First real release
  132.  
  133.  o SFPtoPK didn't print a message if it couldn't find the kern file
  134.  
  135.  o Added none.lig, none.krn, and none.map
  136.  
  137.  Version 1.2
  138.  
  139.  o Tentative real release, last beta
  140.  
  141.  Versions prior to 1.2
  142.  
  143.  o To save paper, changes made prior to version 1.2 are no longer reported
  144.  
  145. Usage
  146. -----
  147.  
  148. SFPtoPK is run from the DOS command prompt. In order to keep the program
  149. small and simple, a command-line interface has been chosen instead of
  150. something more user-friendly.Many of the options have reasonable default
  151. values and these can be set with a configuration file. The configuration
  152. file is described below.The general format for running SFPtoPK looks like
  153. this:
  154.  
  155. SFPTOPK softfont[.sfp] <pkfile[.pk]> <plfile[.pl]> </option1:value1>
  156.                                                    </optionn:valuen>
  157.  
  158. Where:
  159.  
  160. softfont[.sfp]  is the name of the HP LaserJet softfont file to convert to
  161.                 TeX format.
  162.  
  163. pkfile[.pk]     is the name of the TeX PK file to create. By default,
  164.                 SFPtoPK will use the root name of the softfont file as the
  165.                 root name for the PK file.
  166.  
  167. plfile[.pl]     is the name of the TeX PL file to create. In order to use
  168.                 the PK file created by SFPtoPK in TeX, you will also have
  169.                 to use the standard TeXware utility PLtoTF to create a TFM
  170.                 file from the PL file. By default, SFPtoPK will use the
  171.                 root name of the PK file as the root name for the PL file.
  172.  
  173. /option         is one of the following options: /map, /lig, /minchar,
  174.                 /maxchar, /slantchar, /spacechar, /spaceadj, /spacenorm,
  175.                 /spacebold, /spaceital, /spacehmi, /xchar, /xadj, /krn,
  176.                 /krows, /kcols, /kpdots, /kmax, /kadj, /ktbl, or
  177.                 /auto.These options allow you to adjust the TeX font that
  178.                 SFPtoPK produces. Each of these options is described in
  179.                 more detail below.
  180.  
  181. Options
  182. -------
  183.  
  184. /map:filename
  185. -------------
  186.  
  187. HP softfonts frequently contain many of the ligatures and accents TeX uses
  188. but they are in different ASCII positions; the /map option allows you to
  189. rearrange characters in the font. Each line in the map file should identify
  190. two characters (ASCII positions really), the character in the first
  191. position in the softfont will be moved to the second position in the PK
  192. file.
  193.  
  194. A word about characters: whenever SFPtoPK expects a character specification
  195. in a file (or a command line option), it can be done in four different
  196. ways.These four ways correspond to TeX notational conventions for
  197. indicating decimal, octal, and hexidecimal numbers and literal characters.
  198. The first way is to simply indicate the ASCII position with a decimal
  199. number (65, for example), the second way is to indicate the position with
  200. an octal number prefixed with a ' character ('101), the third way is to use
  201. an hexidecimal number prefixed with a " character ("41), and the fourth way
  202. is to use a character constant prefixed with a ` character (`A).
  203.  
  204. Consider, for example, the following lines from a map file:
  205.  
  206. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  207. % This is a substitution map for \SFPtoPK.  This map is for HP softfonts
  208. % with symbol set 10J (PS Text).
  209. "A1 '074
  210. 170 '134
  211. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  212.  
  213. If this map file is used, the character at position A1 (hex) in the
  214. softfont file will appear in position 74 (octal) in the PK file (similarly
  215. for 170 (decimal) and 134 (octal), etc). As you can see, %-style comments
  216. are allowed in the map file.
  217.  
  218. The default mapping for all characters not present in the map file is to
  219. it's ``natural'' position, the same position it has in the softfont file,
  220. in the PK file. SFPtoPK will only use this mapping if the position is
  221. available in the PK file (i.e. if no other character has been mapped to
  222. that position).
  223.  
  224. If the second ``character'' in the map-pair is the word REMOVE, the
  225. softfont character will not be present in it's natural position in the PK
  226. file even if the position is available.
  227.  
  228. Mapping has a higher precedence than removing. An attempt to remove a
  229. character that has been explicitly mapped will produce a warning message
  230. and the character will not be removed. For example, if the map file 
  231. indicates that the character at position "7F should come from position "BA 
  232. in the softfont and that the character at position "7F should be removed, 
  233. the character will come from "BA even if the remove command appears later 
  234. in the map file.It is obviously silly to attempt to do both, and the 
  235. warning message will give you a clue that you have done something wrong. (I 
  236. spent more than an hour looking for a bug in SFPtoPK before I discovered 
  237. that I'd made a typo in my map file :::).
  238.  
  239. The map file also allows several options for manipulating character 
  240. accents. When the character is mapped to it's new position, you may specify 
  241. that only the accent or only the character is to be moved. It is even 
  242. possible to specify that only baseline accents (like the cydil `` '') 
  243. should be moved.In this way it is possible to form dotless 's and 's for 
  244. TeX and to take accents that are not present as individual symbols off of 
  245. characters that have t